<!DOCTYPE html>
<html>

<head>
  <title>Quarkus developer joy for VS Code</title>
  <script id="adobe_dtm" src="https://www.redhat.com/dtm.js" type="text/javascript"></script>
  <script src="/assets/javascript/highlight.pack.js" type="text/javascript"></script>
  <META HTTP-EQUIV='Content-Security-Policy' CONTENT="default-src 'none'; script-src 'self' 'unsafe-eval' 'sha256-ANpuoVzuSex6VhqpYgsG25OHWVA1I+F6aGU04LoI+5s=' 'sha256-ipy9P/3rZZW06mTLAR0EnXvxSNcnfSDPLDuh3kzbB1w=' js.bizographics.com https://www.redhat.com assets.adobedtm.com jsonip.com https://ajax.googleapis.com https://www.googletagmanager.com https://www.google-analytics.com https://use.fontawesome.com; style-src 'self' https://fonts.googleapis.com https://use.fontawesome.com; img-src 'self' *; media-src 'self' ; frame-src https://www.googletagmanager.com https://www.youtube.com; frame-ancestors 'none'; base-uri 'none'; object-src 'none'; form-action 'none'; font-src 'self' https://use.fontawesome.com https://fonts.gstatic.com;">
  <META HTTP-EQUIV='X-Frame-Options' CONTENT="DENY">
  <META HTTP-EQUIV='X-XSS-Protection' CONTENT="1; mode=block">
  <META HTTP-EQUIV='X-Content-Type-Options' CONTENT="nosniff">
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="description" content="Quarkus: Supersonic Subatomic Java">
  <meta name="twitter:card" content="summary_large_image">
  <meta name="twitter:site" content="@QuarkusIO"> 
  <meta name="twitter:creator" content="@QuarkusIO">
  <meta property="og:url" content="https://quarkus.io/blog/quarkus-developer-joy-for-vs-code/" />
  <meta property="og:title" content="Quarkus developer joy for VS Code" />
  <meta property="og:description" content="Quarkus: Supersonic Subatomic Java" />
  <meta property="og:image" content="/assets/images/quarkus_card.png" />
  <link rel="canonical" href="https://quarkus.io/blog/quarkus-developer-joy-for-vs-code/">
  <link rel="shortcut icon" type="image/png" href="/favicon.ico" >
  <link rel="stylesheet" href="https://quarkus.io/guides/stylesheet/config.css" />
  <link rel="stylesheet" href="/assets/css/main.css" />
  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
  <link rel="alternate" type="application/rss+xml"  href="https://quarkus.io/feed.xml" title="Quarkus">
  <script src="https://quarkus.io/assets/javascript/goan.js" type="text/javascript"></script>
  <script src="https://quarkus.io/assets/javascript/hl.js" type="text/javascript"></script>
</head>

<body class="post">
  <!-- Google Tag Manager (noscript) -->
  <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NJWS5L"
  height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
  <!-- End Google Tag Manager (noscript) -->

  <div class="nav-wrapper">
  <div class="grid-wrapper">
    <div class="width-12-12">
      <input type="checkbox" id="checkbox" />
      <nav id="main-nav" class="main-nav">
  <div class="container">
    <div class="logo-wrapper">
      
        <a href="/"><img src="/assets/images/quarkus_logo_horizontal_rgb_600px_reverse.png" class="project-logo" title="Quarkus"></a>
      
    </div>
    <label class="nav-toggle" for="checkbox">
      <i class="fa fa-bars"></i>
    </label>
    <div id="menu" class="menu">
      <span>
        <a href="/get-started/" class="">Get Started</a>
      </span>
      <span>
        <a href="/guides/" class="">Guides</a>
      </span>
      <span>
        <a href="/community/" class="">Community</a>
      </span>
      <span>
        <a href="/support/" class="">Support</a>
      </span>
      <span>
        <a href="/blog/" class="active">Blog</a>
      </span>
      <span>
        <a href="https://code.quarkus.io" class="button-cta secondary white">Start Coding</a>
      </span>
    </div>
  </div>
      </nav>
    </div>
  </div>
</div>

  <div class="content">
    <div class="post-page grid-wrapper">
  <div class="width-8-12 width-12-12-m doc-content">
    <div class="grid-wrapper">
      <div class="width-12-12">
        <p>
          <a href="/blog"><i class="fas fa-angle-left"></i> Back to all posts</a>
        </p>
      </div>
      <div class="width-12-12">
        <div class="post-date">
          September 23, 2019 
          
            <span class="tags"><a href="/blog/tag/announcement">#announcement</a><a href="/blog/tag/ide">#ide</a></span>
          
        </div>
        <h1 class="post-title">Quarkus developer joy for VS Code</h1>
        <div class="grid-wrapper">
          <div class="width-8-12 width-12-12-m byline-wrapper">
            
            
              <img class="headshot" src="https://www.gravatar.com/avatar/ddbf60c0e87ce6ad86f98aaf4fa55ff0">
            
            <p class="byline">By David Kwon</p>
          </div>
          <div class="width-12-12">
              <div class="paragraph">
<p>Earlier this year, we have been introduced to Quarkus, the next-generation, container-first framework for Java applications.
As expected, such new frameworks and technologies make way for new developer tools focused on making
the development experience even better.
The recent <a href="https://marketplace.visualstudio.com/items?itemName=redhat.vscode-quarkus">Quarkus Tools for Visual Studio Code release</a>
aims to do just that,
by bringing features specific to Quarkus project development within VS Code.</p>
</div>
<div class="paragraph">
<p>The VS Code extension was <a href="https://github.com/tsurdilo/quarkus-vsc">originally</a> started as a project by <a href="https://github.com/tsurdilo">Tihomir Surdilovic</a>, from the Business Automation Team at Red Hat and became the foundation of today&#8217;s version.</p>
</div>
<div class="paragraph">
<p>This blog post outlines what Quarkus Tools for Visual Studio Code has to offer so far:
convenient features for an already convenient Java framework.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>Quarkus Tools for Visual Studio Code is dependent on a couple of Java extensions for VS Code,
so it is recommended that you have the
<a href="https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack">Java Extension Pack</a> installed.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>For more detailed information about Quarkus Tools for Visual Studio Code,
check out the
<a href="https://github.com/redhat-developer/vscode-quarkus">GitHub repository</a>.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Watch a demo of Quarkus Tools for Visual Studio Code:</p>
</div>
<div class="videoblock">
<div class="content">
<iframe width="640" height="360" src="https://www.youtube.com/embed/XMrLP_7IbW0?rel=0" frameborder="0" allowfullscreen></iframe>
</div>
</div>
<div class="sect1">
<h2 id="features"><a class="anchor" href="#features"></a>Features</h2>
<div class="sectionbody">
<div class="ulist">
<ul>
<li>
<p><a href="#generating-a-maven-based-quarkus-project">Generating a Maven-based Quarkus project</a></p>
</li>
<li>
<p><a href="#snippet-support">Snippet support</a></p>
</li>
<li>
<p><a href="#adding-quarkus-extensions-to-a-quarkus-project">Adding Quarkus extensions to a Quarkus project</a></p>
</li>
<li>
<p><a href="#debugging-a-quarkus-project">Debugging a Quarkus project</a></p>
</li>
<li>
<p><a href="#tree-view-for-application-properties">Tree view for application.properties</a></p>
</li>
<li>
<p><a href="#hover-and-documentation-for-application-properties">Hover and documentation for application.properties</a></p>
</li>
<li>
<p><a href="#completion-for-application-properties">Completion for application.properties</a></p>
</li>
<li>
<p><a href="#validation-for-application-properties">Validation for application.properties</a></p>
</li>
</ul>
</div>
<div class="sect2">
<h3 id="generating-a-maven-based-quarkus-project"><a class="anchor" href="#generating-a-maven-based-quarkus-project"></a>Generating a Maven-based Quarkus project</h3>
<div class="paragraph">
<p>Previously, generating a Maven-based Quarkus project required you to run a Maven command or create a
project with <a href="https://code.quarkus.io/">code.quarkus.io</a>.
Now you can create a new project right from a user interface in VS Code.
This can be done through a new wizard that generates Maven-based Quarkus
projects with the latest version of Quarkus.</p>
</div>
<div class="paragraph">
<p>To launch the wizard call the <code>Quarkus: Generate a Maven project</code> command
from the command palette.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/01_project_wizard.gif" alt="Going through the project generation wizard">
</div>
</div>
<div class="paragraph">
<p>The wizard will ask you for the project’s groupId, artifactId, project version,
package name, resource name, and target directory.
It also lets you select Quarkus extensions to add to your new project.
If you selected Quarkus extensions through the wizard before,
the "Last Used" option lets you easily select all previously chosen extensions.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/02_last_used_option.png" alt="The 'last used' option">
</div>
</div>
<div class="paragraph">
<p>After the project is generated, VS Code will automatically open a new window
with the folder containing the new Quarkus project.
Alongside the project files, Maven wrapper files are also included.</p>
</div>
</div>
<div class="sect2">
<h3 id="snippet-support"><a class="anchor" href="#snippet-support"></a>Snippet support</h3>
<div class="paragraph">
<p>The VS Code extension provides snippets to create new Quarkus resources and tests,
which can help speed up your workflow.
You can use these snippets by calling the <code>Insert Snippet</code> VS Code command
or by simply typing the snippet prefix in a Java file.
Pressing tab will place the cursor to the next location of interest.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/03_snippet.gif" alt="Using snippets">
</div>
</div>
</div>
<div class="sect2">
<h3 id="adding-quarkus-extensions-to-a-quarkus-project"><a class="anchor" href="#adding-quarkus-extensions-to-a-quarkus-project"></a>Adding Quarkus extensions to a Quarkus project</h3>
<div class="paragraph">
<p>The VS Code extension provides a separate wizard for adding Quarkus extensions to the current project.</p>
</div>
<div class="paragraph">
<p>To launch the wizard call the <code>Quarkus: Add extensions to current project</code> command
from the command palette.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/04_add_extension_wizard.gif" alt="Add extensions wizard">
</div>
</div>
<div class="paragraph">
<p>After selecting the desired Quarkus extension(s),
the Maven command to add the selected extensions will run in VS Code’s
integrated terminal.</p>
</div>
</div>
<div class="sect2">
<h3 id="debugging-a-quarkus-project"><a class="anchor" href="#debugging-a-quarkus-project"></a>Debugging a Quarkus project</h3>
<div class="paragraph">
<p>Starting a debug session with the VS Code extension’s debug command
automatically creates and adds a new VS Code task and debug configuration
in the project folder.
This step allows VS Code to automatically start the Quarkus application by running the
<code>quarkus:dev</code> command when you start a debug session.
The debugger will attach to the application right after it starts.
When closing the debug session, you are provided with options to terminate
the Quarkus application or keep it running.</p>
</div>
<div class="paragraph">
<p>The debug command is: <code>Quarkus: Debug current Quarkus project</code>.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/05_debug_term.png" alt="Message when terminating debug">
</div>
</div>
</div>
<div class="sect2">
<h3 id="tree-view-for-application-properties"><a class="anchor" href="#tree-view-for-application-properties"></a>Tree view for application.properties</h3>
<div class="paragraph">
<p>Upon opening the application.properties file, the VS Code explorer outline
will provide you with a tree view containing all property keys and values.
This feature is especially useful for large application.properties
files because it groups properties by their namespace and profile.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/06_tree_view.png" alt="Tree view">
</div>
</div>
</div>
<div class="sect2">
<h3 id="hover-and-documentation-for-application-properties"><a class="anchor" href="#hover-and-documentation-for-application-properties"></a>Hover and documentation for application.properties</h3>
<div class="paragraph">
<p>The ability to hover over property keys makes it easy to view the property’s
documentation.
The documentation provides the property key’s value type,
default value (if it exists),
phase (whether the property applies at Quarkus runtime or build time),
and the extension name.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/07_hovering.png" alt="Hover over property key">
</div>
</div>
</div>
<div class="sect2">
<h3 id="completion-for-application-properties"><a class="anchor" href="#completion-for-application-properties"></a>Completion for application.properties</h3>
<div class="paragraph">
<p>As of now, there are more than 400 possible predefined Quarkus properties
that could appear in an application.properties file.
I challenge you to remember them all :).
Because of the vast number of properties that could be configured,
property key and value completion prove useful to anyone working with
the application.properties file.</p>
</div>
<div class="paragraph">
<p>After opening the application.properties file,
you can receive property key completion options as you type,
or with the Ctrl+Space (⌥+Space for macOS) keyboard shortcut.
The list of completion options is in sync with the Quarkus extensions that
are currently available to the project.
That means, whenever Quarkus extensions are added or removed,
the list of completion options will be updated to provide you with
the relevant completion options.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/08_key_completion.gif" alt="Property key completion">
</div>
</div>
<div class="paragraph">
<p>If the property key has a default value,
it will be inserted automatically as a part of the completion.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/09_default_value_completion.gif" alt="Default value completion">
</div>
</div>
<div class="paragraph">
<p>Completion is also available for enumerated type and boolean values.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/10_enum_bool_completion.gif" alt="Value completion">
</div>
</div>
<div class="paragraph">
<p>There is also completion support for mapped properties.
Pressing tab after editing the property will place the cursor to the next location.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/11_map_property.gif" alt="Mapped properties">
</div>
</div>
</div>
<div class="sect2">
<h3 id="validation-for-application-properties"><a class="anchor" href="#validation-for-application-properties"></a>Validation for application.properties</h3>
<div class="paragraph">
<p>Last but not least, we have validation support for application.properties.
We currently provide validation support for unknown properties,
duplicate properties, and for missing equals signs.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/assets/images/posts/quarkus-vs-code/12_validation.png" alt="Validation">
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="next-steps"><a class="anchor" href="#next-steps"></a>Next steps</h2>
<div class="sectionbody">
<div class="paragraph">
<p>As you can see, Quarkus Tools for Visual Studio Code has great features to
help provide a seamless developer experience and promote Quarkus project
development within VS Code.
However, this does not mean that the extension is perfect and bug-free;
it is still being improved.
We aspire to add new features (such as a CodeLens feature that would
open REST endpoint URLs in a web browser) and improve existing features
(such as completion, validation, snippets).</p>
</div>
<div class="paragraph">
<p>If you prefer IDEs such as Eclipse and IntelliJ IDEA,
the good news is that Quarkus tooling for those IDEs are currently in progress.
Because the application.properties features are provided via the
<a href="https://microsoft.github.io/language-server-protocol/">Language Server Protocol (LSP)</a>,
it is possible to provide the same features to other editors and IDEs.</p>
</div>
<div class="paragraph">
<p>If you have any issues or feature requests, please let us know by creating a GitHub issue
<a href="https://github.com/redhat-developer/vscode-quarkus/issues">here</a>.
We would be very happy to listen to any suggestions for improvement.
If you would like to contribute to the project,
the contributing guide is located in the GitHub repository
<a href="https://github.com/redhat-developer/vscode-quarkus/blob/master/CONTRIBUTING.md">here</a>.</p>
</div>
<div class="paragraph">
<p>Thank you for reading!</p>
</div>
</div>
</div>
              
          </div>
          <div class="width-12-12"><div class="share-page">
  <a class="share-linkedin" href="https://www.linkedin.com/shareArticle?mini=true&url=https://quarkus.io/blog/quarkus-developer-joy-for-vs-code/&title=Quarkus developer joy for VS Code" rel="nofollow" target="_blank" title="Share on LinkedIn">
    <img src="/assets/images/share-page/icons_social-linkedin.png"/>
  </a>
  <a class="share-twitter" href="https://twitter.com/intent/tweet?text=Quarkus developer joy for VS Code&url=https://quarkus.io/blog/quarkus-developer-joy-for-vs-code/&via=quarkusio&related=quarkusio" rel="nofollow" target="_blank" title="Share on Twitter">
    <img src="/assets/images/share-page/icons_social-twitter.png"/>
  </a>
  <a class="share-facebook" href="https://facebook.com/sharer.php?u=https://quarkus.io/blog/quarkus-developer-joy-for-vs-code/" rel="nofollow" target="_blank" title="Share on Facebook">
    <img src="/assets/images/share-page/icons_social-facebook.png"/>
  </a>
  <a class="share-reddit" href="http://www.reddit.com/submit?url=https://quarkus.io/blog/quarkus-developer-joy-for-vs-code/" onclick="window.open(this.href, 'pop-up', 'left=20,top=20,width=900,height=500,toolbar=1,resizable=0'); return false;" title="Share on Reddit" >
    <img src="/assets/images/share-page/icons_social-reddit.png"/>
  </a>
  <a class="share-email" href="mailto:?subject=Quarkus developer joy for VS Code&amp;body=Quarkus developer joy for VS Code https://quarkus.io/blog/quarkus-developer-joy-for-vs-code/" title="Share via Email" >
    <img src="/assets/images/share-page/icons_social-email.png"/>
  </a>
</div>
</div>
        </div>
      </div>
    </div>
  </div>
</div>

  </div>

  <div class="content project-footer">
  <div class="footer-section">
    <div class="logo-wrapper">
      <a href="/"><img src="/assets/images/quarkus_logo_horizontal_rgb_reverse.svg" class="project-logo" title="Quarkus"></a>
    </div>
  </div>
  <div class="grid-wrapper">
    <p class="grid__item width-3-12">Quarkus is open. All dependencies of this project are available under the <a href='https://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache Software License 2.0</a> or compatible license.<br /><br />This website was built with <a href='https://jekyllrb.com/' target='_blank'>Jekyll</a>, is hosted on <a href='https://pages.github.com/' target='_blank'>Github Pages</a> and is completely open source. If you want to make it better, <a href='https://github.com/quarkusio/quarkusio.github.io' target='_blank'>fork the website</a> and show us what you’ve got.</p>

    
      <div class="width-1-12 project-links">
        <span>Navigation</span>
        <ul class="footer-links width-1-12">
          
            <li><a href="/">Home</a></li>
          
            <li><a href="/guides">Guides</a></li>
          
            <li><a href="/community/#contributing">Contribute</a></li>
          
            <li><a href="/faq">FAQ</a></li>
          
            <li><a href="/get-started">Get Started</a></li>
          
        </ul>
      </div>
    
      <div class="width-1-12 project-links">
        <span>Contribute</span>
        <ul class="footer-links width-1-12">
          
            <li><a href="https://twitter.com/quarkusio">Follow us</a></li>
          
            <li><a href="https://github.com/quarkusio">GitHub</a></li>
          
            <li><a href="/security">Security&nbsp;policy</a></li>
          
        </ul>
      </div>
    
      <div class="width-1-12 project-links">
        <span>Get Help</span>
        <ul class="footer-links width-1-12">
          
            <li><a href="https://groups.google.com/forum/#!forum/quarkus-dev">Forums</a></li>
          
            <li><a href="https://quarkusio.zulipchat.com">Chatroom</a></li>
          
        </ul>
      </div>
    

    
      <div class="width-3-12 more-links">
        <span>Quarkus is made of community projects</span>
        <ul class="footer-links">
          
            <li><a href="https://vertx.io/" target="_blank">Eclipse Vert.x</a></li>
          
            <li><a href="https://microprofile.io" target="_blank">Eclipse MicroProfile</a></li>
          
            <li><a href="https://hibernate.org" target="_blank">Hibernate</a></li>
          
            <li><a href="https://netty.io" target="_blank">Netty</a></li>
          
            <li><a href="https://resteasy.github.io" target="_blank">RESTEasy</a></li>
          
            <li><a href="https://camel.apache.org" target="_blank">Apache Camel</a></li>
          
            <li><a href="https://code.quarkus.io/" target="_blank">And many more...</a></li>
          
        </ul>
      </div>
    
  </div>
</div>
  <div class="content redhat-footer">
  <div class="grid-wrapper">
    <span class="licence">
      <i class="fab fa-creative-commons"></i><i class="fab fa-creative-commons-by"></i> <a href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC by 3.0</a> | <a href="https://www.redhat.com/en/about/privacy-policy">Privacy Policy</a>
    </span>
    <span class="redhat">
      Sponsored by
    </span>
    <span class="redhat-logo">
      <a href="https://www.redhat.com/" target="_blank"><img src="/assets/images/redhat_reversed.svg"></a>
    </span>
  </div>
</div>


  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js" integrity="sha384-8gBf6Y4YYq7Jx97PIqmTwLPin4hxIzQw5aDmUg/DDhul9fFpbbLcLh3nTIIDJKhx" crossorigin="anonymous"></script>
  <script type="text/javascript" src="/assets/javascript/mobile-nav.js"></script>
  <script type="text/javascript" src="/assets/javascript/scroll-down.js"></script>
  <script src="/assets/javascript/satellite.js" type="text/javascript"></script>
  <script src="https://quarkus.io/guides/javascript/config.js" type="text/javascript"></script>
  <script src="/assets/javascript/search-filter.js" type="text/javascript"></script>
  <script src="/assets/javascript/back-to-top.js" type="text/javascript"></script>
</body>

</html>
